Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update description variable name #24

Merged
merged 2 commits into from
Apr 11, 2018
Merged

update description variable name #24

merged 2 commits into from
Apr 11, 2018

Conversation

jbjonesjr
Copy link
Contributor

fixes #22

@jbjonesjr jbjonesjr requested a review from bkeepers March 15, 2018 00:53
@bkeepers
Copy link
Contributor

Hmm, when I run this locally, it doesn't ask for the description for the app:

$ bin/create-probot-app.js foobar
Let's create a Probot app!
? App name: foobar
? Author's full name: Brandon Keepers
? Author's email address: [email protected]
? Homepage: 
? GitHub user or org name: bkeepers
? Repository name: foobar
created file: /Users/bkeepers/projects/probot/create-probot-plugin/foobar/.env.example
created file: /Users/bkeepers/projects/probot/create-probot-plugin/foobar/.gitignore
created file: /Users/bkeepers/projects/probot/create-probot-plugin/foobar/.travis.yml
created file: /Users/bkeepers/projects/probot/create-probot-plugin/foobar/CODE_OF_CONDUCT.md
created file: /Users/bkeepers/projects/probot/create-probot-plugin/foobar/CONTRIBUTING.md
created file: /Users/bkeepers/projects/probot/create-probot-plugin/foobar/LICENSE
created file: /Users/bkeepers/projects/probot/create-probot-plugin/foobar/README.md
created file: /Users/bkeepers/projects/probot/create-probot-plugin/foobar/index.js
created file: /Users/bkeepers/projects/probot/create-probot-plugin/foobar/package.json
created file: /Users/bkeepers/projects/probot/create-probot-plugin/foobar/__tests__/index.test.js
created file: /Users/bkeepers/projects/probot/create-probot-plugin/foobar/docs/deploy.md

@bkeepers
Copy link
Contributor

vs on master:

$ bin/create-probot-app.js wat   
Let's create a Probot app!
? App name: wat
? Description of app: (A Probot app) 
…

@jbjonesjr
Copy link
Contributor Author

so weird.... i'll play around more with this to see what could be up

@jbjonesjr
Copy link
Contributor Author

jbjonesjr commented Mar 21, 2018 •
edited
Loading

initial testing seems to show that description is a magic word within the commander module (program in this code).

Sample [npmjs.com/package/commander]:

program
  .command('setup [env]')
  .description('run setup commands for all envs')
  .option("-s, --setup_mode [mode]", "Which setup mode to use")
  .action(function(env, options){
...

At the end of the day, it's the answers hash provided by the inquirer package that is used by the template, so as long as that is named description, downstream should work.

@jbjonesjr
Copy link
Contributor Author

ran tests locally, looks like the description is now in the README.md and the package.json file. LGTM.

@bkeepers bkeepers merged commit e2fa09a into master Apr 11, 2018
@bkeepers
Copy link
Contributor

Thanks!

@bkeepers bkeepers deleted the description-patch branch April 11, 2018 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bkeepers bkeepers Awaiting requested review from bkeepers

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Descriptions are not auto-populated into template
2 participants
@jbjonesjr @bkeepers